/*
 * Copyright 2012-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.annotation.ImportCandidates;
import org.springframework.context.annotation.AnnotationBeanNameGenerator;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.AliasFor;
import org.springframework.core.io.support.SpringFactoriesLoader;

/**
 * 表示某个类提供了可以被 Spring Boot 自动应用的配置。
 * 自动配置类是常规的 {@link Configuration @Configuration} 类，但
 * {@literal Configuration#proxyBeanMethods() proxyBeanMethods} 总是 {@code false}。
 * <p>
 * 它们通过 {@link ImportCandidates} 和 {@link SpringFactoriesLoader} 机制（以 {@link EnableAutoConfiguration} 为键）
 * 来定位。
 * <p>
 * 通常，自动配置类都会被标记为 {@link Conditional @Conditional}，
 * 通常使用 {@link ConditionalOnClass @ConditionalOnClass} 和
 * {@link ConditionalOnMissingBean @ConditionalOnMissingBean} 注解。
 *
 * @author Moritz Halbritter
 * @see EnableAutoConfiguration
 * @see AutoConfigureBefore
 * @see AutoConfigureAfter
 * @see Conditional
 * @see ConditionalOnClass
 * @see ConditionalOnMissingBean
 * @since 2.7.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration(proxyBeanMethods = false)
@AutoConfigureBefore
@AutoConfigureAfter
public @interface AutoConfiguration {

	/**
	 * 显式指定与 {@code @AutoConfiguration} 类关联的 Spring Bean 定义的名称。
	 * 如果不指定（常见情况），则会自动生成 Bean 名称。
	 * <p>
	 * 只有当 {@code @AutoConfiguration} 类通过组件扫描或直接传递给
	 * {@link AnnotationConfigApplicationContext} 时，自定义名称才生效。
	 * 如果该类是通过传统 XML Bean 定义注册，则 Bean 元素的名称/ID 优先。
	 * @return 显式组件名称（如果有），否则为空字符串
	 * @see AnnotationBeanNameGenerator
	 */
	@AliasFor(annotation = Configuration.class)
	String value() default "";

	/**
	 * 尚未应用的自动配置类。
	 * @return 这些类
	 */
	@AliasFor(annotation = AutoConfigureBefore.class, attribute = "value")
	Class<?>[] before() default {};

	/**
	 * 尚未应用的自动配置类名称。
	 * @return 类名数组
	 */
	@AliasFor(annotation = AutoConfigureBefore.class, attribute = "name")
	String[] beforeName() default {};

	/**
	 * 已经应用的自动配置类。
	 * @return 这些类
	 */
	@AliasFor(annotation = AutoConfigureAfter.class, attribute = "value")
	Class<?>[] after() default {};

	/**
	 * 已经应用的自动配置类名称。
	 * @return 类名数组
	 */
	@AliasFor(annotation = AutoConfigureAfter.class, attribute = "name")
	String[] afterName() default {};

}
